Returns the Submodel in the ValueOnly representation

Returns the Submodel in the ValueOnly representation

Query Parameters

• level string

  Possible values: [deep]

  Default value: deep

  Determines the structural depth of the respective resource content

• extent string

  Possible values: [withBlobValue]

  Default value: withoutBlobValue

  Determines to which extent the resource is being serialized

Responses

• 200
• 400
• 401
• 403
• 500
• default

---

ValueOnly representation of the Submodel

application/json

• Schema
• Example (from schema)

---

Schema

• submodelElements object[]

  Possible values: >= 1

{
  "submodelElements": [
    {
      "extensions": [
        {
          "semanticId": {
            "type": "ExternalReference",
            "keys": [
              {
                "type": "AnnotatedRelationshipElement",
                "value": "string"
              }
            ],
            "referredSemanticId": {
              "type": "ExternalReference",
              "keys": [
                {
                  "type": "AnnotatedRelationshipElement",
                  "value": "string"
                }
              ]
            }
          },
          "supplementalSemanticIds": [
            {
              "type": "ExternalReference",
              "keys": [
                {
                  "type": "AnnotatedRelationshipElement",
                  "value": "string"
                }
              ],
              "referredSemanticId": {
                "type": "ExternalReference",
                "keys": [
                  {
                    "type": "AnnotatedRelationshipElement",
                    "value": "string"
                  }
                ]
              }
            }
          ],
          "name": "string",
          "valueType": "xs:anyURI",
          "value": "string",
          "refersTo": [
            {
              "type": "ExternalReference",
              "keys": [
                {
                  "type": "AnnotatedRelationshipElement",
                  "value": "string"
                }
              ],
              "referredSemanticId": {
                "type": "ExternalReference",
                "keys": [
                  {
                    "type": "AnnotatedRelationshipElement",
                    "value": "string"
                  }
                ]
              }
            }
          ]
        }
      ],
      "category": "string",
      "idShort": "string",
      "displayName": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "description": [
        {
          "language": "string",
          "text": "string"
        }
      ],
      "modelType": "AnnotatedRelationshipElement",
      "semanticId": {
        "type": "ExternalReference",
        "keys": [
          {
            "type": "AnnotatedRelationshipElement",
            "value": "string"
          }
        ],
        "referredSemanticId": {
          "type": "ExternalReference",
          "keys": [
            {
              "type": "AnnotatedRelationshipElement",
              "value": "string"
            }
          ]
        }
      },
      "supplementalSemanticIds": [
        {
          "type": "ExternalReference",
          "keys": [
            {
              "type": "AnnotatedRelationshipElement",
              "value": "string"
            }
          ],
          "referredSemanticId": {
            "type": "ExternalReference",
            "keys": [
              {
                "type": "AnnotatedRelationshipElement",
                "value": "string"
              }
            ]
          }
        }
      ],
      "qualifiers": [
        {
          "semanticId": {
            "type": "ExternalReference",
            "keys": [
              {
                "type": "AnnotatedRelationshipElement",
                "value": "string"
              }
            ],
            "referredSemanticId": {
              "type": "ExternalReference",
              "keys": [
                {
                  "type": "AnnotatedRelationshipElement",
                  "value": "string"
                }
              ]
            }
          },
          "supplementalSemanticIds": [
            {
              "type": "ExternalReference",
              "keys": [
                {
                  "type": "AnnotatedRelationshipElement",
                  "value": "string"
                }
              ],
              "referredSemanticId": {
                "type": "ExternalReference",
                "keys": [
                  {
                    "type": "AnnotatedRelationshipElement",
                    "value": "string"
                  }
                ]
              }
            }
          ],
          "kind": "ConceptQualifier",
          "type": "string",
          "valueType": "xs:anyURI",
          "value": "string",
          "valueId": {
            "type": "ExternalReference",
            "keys": [
              {
                "type": "AnnotatedRelationshipElement",
                "value": "string"
              }
            ],
            "referredSemanticId": {
              "type": "ExternalReference",
              "keys": [
                {
                  "type": "AnnotatedRelationshipElement",
                  "value": "string"
                }
              ]
            }
          }
        }
      ],
      "embeddedDataSpecifications": [
        {
          "dataSpecification": {
            "type": "ExternalReference",
            "keys": [
              {
                "type": "AnnotatedRelationshipElement",
                "value": "string"
              }
            ],
            "referredSemanticId": {
              "type": "ExternalReference",
              "keys": [
                {
                  "type": "AnnotatedRelationshipElement",
                  "value": "string"
                }
              ]
            }
          },
          "dataSpecificationContent": {
            "modelType": "AnnotatedRelationshipElement",
            "preferredName": [
              {
                "language": "string",
                "text": "string"
              }
            ],
            "shortName": [
              {
                "language": "string",
                "text": "string"
              }
            ],
            "unit": "string",
            "unitId": {
              "type": "ExternalReference",
              "keys": [
                {
                  "type": "AnnotatedRelationshipElement",
                  "value": "string"
                }
              ],
              "referredSemanticId": {
                "type": "ExternalReference",
                "keys": [
                  {
                    "type": "AnnotatedRelationshipElement",
                    "value": "string"
                  }
                ]
              }
            },
            "sourceOfDefinition": "string",
            "symbol": "string",
            "dataType": "BLOB",
            "definition": [
              {
                "language": "string",
                "text": "string"
              }
            ],
            "valueFormat": "string",
            "valueList": {
              "valueReferencePairs": [
                {
                  "value": "string",
                  "valueId": {
                    "type": "ExternalReference",
                    "keys": [
                      {
                        "type": "AnnotatedRelationshipElement",
                        "value": "string"
                      }
                    ],
                    "referredSemanticId": {
                      "type": "ExternalReference",
                      "keys": [
                        {
                          "type": "AnnotatedRelationshipElement",
                          "value": "string"
                        }
                      ]
                    }
                  }
                }
              ]
            },
            "value": "string",
            "levelType": {
              "min": true,
              "nom": true,
              "typ": true,
              "max": true
            }
          }
        }
      ]
    }
  ]
}

Bad Request, e.g. the request parameters of the format of the request body is wrong.

application/json

• Schema
• Example (from schema)

---

Schema

• messages object[]

  code string

  Possible values: non-empty and <= 32 characters

  correlationId string

  Possible values: non-empty and <= 128 characters

  messageType string

  Possible values: [Undefined, Info, Warning, Error, Exception]

  text string

  timestamp string

  Possible values: Value must match regular expression ^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\.[0-9]+)?)|24:00:00(\.0+)?)(Z|\+00:00|-00:00)$

{
  "messages": [
    {
      "code": "string",
      "correlationId": "string",
      "messageType": "Undefined",
      "text": "string",
      "timestamp": "string"
    }
  ]
}

Unauthorized, e.g. the server refused the authorization attempt.

application/json

• Schema
• Example (from schema)

---

Schema

• messages object[]

  code string

  Possible values: non-empty and <= 32 characters

  correlationId string

  Possible values: non-empty and <= 128 characters

  messageType string

  Possible values: [Undefined, Info, Warning, Error, Exception]

  text string

  timestamp string

  Possible values: Value must match regular expression ^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\.[0-9]+)?)|24:00:00(\.0+)?)(Z|\+00:00|-00:00)$

{
  "messages": [
    {
      "code": "string",
      "correlationId": "string",
      "messageType": "Undefined",
      "text": "string",
      "timestamp": "string"
    }
  ]
}

Forbidden

application/json

• Schema
• Example (from schema)

---

Schema

• messages object[]

  code string

  Possible values: non-empty and <= 32 characters

  correlationId string

  Possible values: non-empty and <= 128 characters

  messageType string

  Possible values: [Undefined, Info, Warning, Error, Exception]

  text string

  timestamp string

  Possible values: Value must match regular expression ^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\.[0-9]+)?)|24:00:00(\.0+)?)(Z|\+00:00|-00:00)$

{
  "messages": [
    {
      "code": "string",
      "correlationId": "string",
      "messageType": "Undefined",
      "text": "string",
      "timestamp": "string"
    }
  ]
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• messages object[]

  code string

  Possible values: non-empty and <= 32 characters

  correlationId string

  Possible values: non-empty and <= 128 characters

  messageType string

  Possible values: [Undefined, Info, Warning, Error, Exception]

  text string

  timestamp string

  Possible values: Value must match regular expression ^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\.[0-9]+)?)|24:00:00(\.0+)?)(Z|\+00:00|-00:00)$

{
  "messages": [
    {
      "code": "string",
      "correlationId": "string",
      "messageType": "Undefined",
      "text": "string",
      "timestamp": "string"
    }
  ]
}

Default error handling for unmentioned status codes

application/json

• Schema
• Example (from schema)

---

Schema

• messages object[]

  code string

  Possible values: non-empty and <= 32 characters

  correlationId string

  Possible values: non-empty and <= 128 characters

  messageType string

  Possible values: [Undefined, Info, Warning, Error, Exception]

  text string

  timestamp string

  Possible values: Value must match regular expression ^-?(([1-9][0-9][0-9][0-9]+)|(0[0-9][0-9][0-9]))-((0[1-9])|(1[0-2]))-((0[1-9])|([12][0-9])|(3[01]))T(((([01][0-9])|(2[0-3])):[0-5][0-9]:([0-5][0-9])(\.[0-9]+)?)|24:00:00(\.0+)?)(Z|\+00:00|-00:00)$

{
  "messages": [
    {
      "code": "string",
      "correlationId": "string",
      "messageType": "Undefined",
      "text": "string",
      "timestamp": "string"
    }
  ]
}

Loading...